Vcenter Identity Providers CreateSpec
The Vcenter Identity Providers CreateSpec schema contains the information used to create an identity provider.
This schema was added in vSphere API 7.0.0.0.
{
"config_tag": "string",
"oauth2": {
"auth_endpoint": "string",
"token_endpoint": "string",
"public_key_uri": "string",
"client_id": "string",
"client_secret": "string",
"claim_map": {
"claim_map": {
"claim_map": [
"string"
]
}
},
"issuer": "string",
"authentication_method": "string",
"auth_query_params": {
"auth_query_params": [
"string"
]
}
},
"oidc": {
"discovery_endpoint": "string",
"client_id": "string",
"client_secret": "string",
"claim_map": {
"claim_map": {
"claim_map": [
"string"
]
}
}
},
"org_ids": [
"string"
],
"is_default": false,
"name": "string",
"domain_names": [
"string"
],
"auth_query_params": {
"auth_query_params": [
"string"
]
},
"idm_protocol": "string",
"idm_endpoints": [
"string"
],
"active_directory_over_ldap": {
"user_name": "string",
"password": "string",
"users_base_dn": "string",
"groups_base_dn": "string",
"server_endpoints": [
"string"
],
"cert_chain": {
"cert_chain": [
"string"
]
}
},
"upn_claim": "string",
"groups_claim": "string",
"federation_type": "string"
}The config type of the identity provider
For more information see: Vcenter Identity Providers ConfigType.
This property was added in vSphere API 7.0.0.0.
OAuth2 CreateSpec
This property was added in vSphere API 7.0.0.0.
This property is optional and it is only relevant when the value of config_tag is Vcenter Identity Providers ConfigType.oauth2.
OIDC CreateSpec
This property was added in vSphere API 7.0.0.0.
This property is optional and it is only relevant when the value of config_tag is Vcenter Identity Providers ConfigType.oidc.
The set of orgIds as part of SDDC creation which provides the basis for tenancy
This property was added in vSphere API 7.0.0.0.
If missing or null, the set will be empty.
Specifies whether the provider is the default provider. Setting is_default of current provider to True makes all other providers non-default.
This property was added in vSphere API 7.0.0.0.
If missing or null the provider will be the default provider if it is the first provider that is created, and will not be the default provider otherwise.
The user friendly name for the provider. This name can be used for human-readable identification purposes, but it does not have to be unique, as the system will use internal UUIDs to differentiate providers.
This property was added in vSphere API 7.0.0.0.
If missing or null, the name will be the empty string
Set of fully qualified domain names to trust when federating with this identity provider. Tokens from this identity provider will only be validated if the user belongs to one of these domains, and any domain-qualified groups in the tokens will be filtered to include only those groups that belong to one of these domains.
This property was added in vSphere API 7.0.0.0.
If missing or null, domainNames will be the empty set and the domain validation behavior at login with this identity provider will be as follows: the user's domain will be parsed from the User Principal Name (UPN) value that is found in the tokens returned by the identity provider. This domain will then be implicitly trusted and used to filter any groups that are also provided in the tokens.
key/value pairs that are to be appended to the authEndpoint request.
How to append to authEndpoint request: If the map is not empty, a "?" is added to the endpoint URL, and combination of each k and each string in the v is added with an "&" delimiter. Details:
- If the value contains only one string, then the key is added with "k=v".
- If the value is an empty list, then the key is added without a "=v".
- If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.
This property was added in vSphere API 7.0.0.0.
If missing or null, the map will be empty.
Communication protocol to the identity management endpoints.
For more information see: Vcenter Identity Providers IdmProtocol.
This property was added in vSphere API 7.0.0.0.
If missing or null, no communication protocol will be configured for the identity provider.
Identity management endpoints. When specified, at least one endpoint must be provided.
This property was added in vSphere API 7.0.0.0.
This property is optional and it is only relevant when the value of idm_protocol is one of Vcenter Identity Providers IdmProtocol.REST, Vcenter Identity Providers IdmProtocol.SCIM, or Vcenter Identity Providers IdmProtocol.scim2_0.
Identity management configuration. If the protocol is LDAP, the configuration must be set, else InvalidArgument is thrown.
This property was added in vSphere API 7.0.0.0.
This property is optional and it is only relevant when the value of idm_protocol is Vcenter Identity Providers IdmProtocol.LDAP.
Specifies which claim provides the user principal name (UPN) for the user.
This property was added in vSphere API 7.0.0.0.
If missing or null, the claim named 'acct' will be used to provide backwards compatibility with CSP.
Specifies which claim provides the group membership for the token subject. These groups will be used for mapping to local groups per the claim map.
This property was added in vSphere API 7.0.0.0.
If missing or null, the default behavior will be CSP backwards compatiblility. The groups for the subject will be comprised of the groups in 'group_names' and 'group_ids' claims.
The type of the identity provider
For more information see: Vcenter Identity FederationType.
This property was added in vSphere API 8.0.1.0.
If missing or null, the federation type value will not be set.